Skip to main content

Interface: ExtendedRTCPeerConnection

Hierarchy​

  • RTCPeerConnection

    ↳ ExtendedRTCPeerConnection

Properties​

canTrickleIceCandidates​

• Readonly canTrickleIceCandidates: null | boolean

Inherited from​

RTCPeerConnection.canTrickleIceCandidates

connectionState​

• Readonly connectionState: RTCPeerConnectionState

Inherited from​

RTCPeerConnection.connectionState

currentLocalDescription​

• Readonly currentLocalDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.currentLocalDescription

currentRemoteDescription​

• Readonly currentRemoteDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.currentRemoteDescription

iceConnectionState​

• Readonly iceConnectionState: RTCIceConnectionState

Inherited from​

RTCPeerConnection.iceConnectionState

iceGatheringState​

• Readonly iceGatheringState: RTCIceGatheringState

Inherited from​

RTCPeerConnection.iceGatheringState

localDescription​

• Readonly localDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.localDescription

onconnectionstatechange​

• onconnectionstatechange: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.onconnectionstatechange

ondatachannel​

• ondatachannel: null | (this: RTCPeerConnection, ev: RTCDataChannelEvent) => any

Inherited from​

RTCPeerConnection.ondatachannel

onicecandidate​

• onicecandidate: null | (this: RTCPeerConnection, ev: RTCPeerConnectionIceEvent) => any

Inherited from​

RTCPeerConnection.onicecandidate

onicecandidateerror​

• onicecandidateerror: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.onicecandidateerror

oniceconnectionstatechange​

• oniceconnectionstatechange: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.oniceconnectionstatechange

onicegatheringstatechange​

• onicegatheringstatechange: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.onicegatheringstatechange

onnegotiationneeded​

• onnegotiationneeded: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.onnegotiationneeded

onsignalingstatechange​

• onsignalingstatechange: null | (this: RTCPeerConnection, ev: Event) => any

Inherited from​

RTCPeerConnection.onsignalingstatechange

ontrack​

• ontrack: null | (this: RTCPeerConnection, ev: RTCTrackEvent) => any

Inherited from​

RTCPeerConnection.ontrack

peerIdentity​

• peerIdentity: Promise<unknown>

pendingLocalDescription​

• Readonly pendingLocalDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.pendingLocalDescription

pendingRemoteDescription​

• Readonly pendingRemoteDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.pendingRemoteDescription

remoteDescription​

• Readonly remoteDescription: null | RTCSessionDescription

Inherited from​

RTCPeerConnection.remoteDescription

sctp​

• Readonly sctp: null | RTCSctpTransport

Inherited from​

RTCPeerConnection.sctp

signalingState​

• Readonly signalingState: RTCSignalingState

Inherited from​

RTCPeerConnection.signalingState

Methods​

addEventListener​

▸ addEventListener<K>(type, listener, options?): void

Type parameters​

NameType
Kextends keyof RTCPeerConnectionEventMap

Parameters​

NameType
typeK
listener(this: RTCPeerConnection, ev: RTCPeerConnectionEventMap[K]) => any
options?boolean | AddEventListenerOptions

Returns​

void

Inherited from​

RTCPeerConnection.addEventListener

▸ addEventListener(type, listener, options?): void

Parameters​

NameType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | AddEventListenerOptions

Returns​

void

Inherited from​

RTCPeerConnection.addEventListener

addIceCandidate​

▸ addIceCandidate(candidate?): Promise<void>

Parameters​

NameType
candidate?RTCIceCandidateInit

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.addIceCandidate

▸ addIceCandidate(candidate, successCallback, failureCallback): Promise<void>

Deprecated

Parameters​

NameType
candidateRTCIceCandidateInit
successCallbackVoidFunction
failureCallbackRTCPeerConnectionErrorCallback

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.addIceCandidate

addTrack​

▸ addTrack(track, ...streams): RTCRtpSender

Parameters​

NameType
trackMediaStreamTrack
...streamsMediaStream[]

Returns​

RTCRtpSender

Inherited from​

RTCPeerConnection.addTrack

addTransceiver​

▸ addTransceiver(trackOrKind, init?): RTCRtpTransceiver

Parameters​

NameType
trackOrKindstring | MediaStreamTrack
init?RTCRtpTransceiverInit

Returns​

RTCRtpTransceiver

Inherited from​

RTCPeerConnection.addTransceiver

close​

▸ close(): void

Returns​

void

Inherited from​

RTCPeerConnection.close

createAnswer​

▸ createAnswer(options?): Promise<RTCSessionDescriptionInit>

Parameters​

NameType
options?RTCAnswerOptions

Returns​

Promise<RTCSessionDescriptionInit>

Inherited from​

RTCPeerConnection.createAnswer

▸ createAnswer(successCallback, failureCallback): Promise<void>

Deprecated

Parameters​

NameType
successCallbackRTCSessionDescriptionCallback
failureCallbackRTCPeerConnectionErrorCallback

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.createAnswer

createDataChannel​

▸ createDataChannel(label, dataChannelDict?): RTCDataChannel

Parameters​

NameType
labelstring
dataChannelDict?RTCDataChannelInit

Returns​

RTCDataChannel

Inherited from​

RTCPeerConnection.createDataChannel

createOffer​

▸ createOffer(options?): Promise<RTCSessionDescriptionInit>

Parameters​

NameType
options?RTCOfferOptions

Returns​

Promise<RTCSessionDescriptionInit>

Inherited from​

RTCPeerConnection.createOffer

▸ createOffer(successCallback, failureCallback, options?): Promise<void>

Deprecated

Parameters​

NameType
successCallbackRTCSessionDescriptionCallback
failureCallbackRTCPeerConnectionErrorCallback
options?RTCOfferOptions

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.createOffer

dispatchEvent​

▸ dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters​

NameType
eventEvent

Returns​

boolean

Inherited from​

RTCPeerConnection.dispatchEvent

getConfiguration​

▸ getConfiguration(): RTCConfiguration

Returns​

RTCConfiguration

Inherited from​

RTCPeerConnection.getConfiguration

getReceivers​

▸ getReceivers(): RTCRtpReceiver[]

Returns​

RTCRtpReceiver[]

Inherited from​

RTCPeerConnection.getReceivers

getSenders​

▸ getSenders(): RTCRtpSender[]

Returns​

RTCRtpSender[]

Inherited from​

RTCPeerConnection.getSenders

getStats​

▸ getStats(selector?): Promise<RTCStatsReport>

Parameters​

NameType
selector?null | MediaStreamTrack

Returns​

Promise<RTCStatsReport>

Inherited from​

RTCPeerConnection.getStats

getTransceivers​

▸ getTransceivers(): RTCRtpTransceiver[]

Returns​

RTCRtpTransceiver[]

Inherited from​

RTCPeerConnection.getTransceivers

removeEventListener​

▸ removeEventListener<K>(type, listener, options?): void

Type parameters​

NameType
Kextends keyof RTCPeerConnectionEventMap

Parameters​

NameType
typeK
listener(this: RTCPeerConnection, ev: RTCPeerConnectionEventMap[K]) => any
options?boolean | EventListenerOptions

Returns​

void

Inherited from​

RTCPeerConnection.removeEventListener

▸ removeEventListener(type, listener, options?): void

Parameters​

NameType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | EventListenerOptions

Returns​

void

Inherited from​

RTCPeerConnection.removeEventListener

removeTrack​

▸ removeTrack(sender): void

Parameters​

NameType
senderRTCRtpSender

Returns​

void

Inherited from​

RTCPeerConnection.removeTrack

restartIce​

▸ restartIce(): void

Typescript DOM type definition has not included this method for RTCPeerConnection, thus patch it manually.

Allow a web application to easily request that ICE candidate gathering be redone on both ends of the connection. This simplifies the process by allowing the same method to be used by either the caller or the receiver to trigger an ICE restart.

https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/restartIce

Returns​

void

Overrides​

RTCPeerConnection.restartIce

setConfiguration​

▸ setConfiguration(configuration?): void

Parameters​

NameType
configuration?RTCConfiguration

Returns​

void

Inherited from​

RTCPeerConnection.setConfiguration

setLocalDescription​

▸ setLocalDescription(description?): Promise<void>

Parameters​

NameType
description?RTCLocalSessionDescriptionInit

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.setLocalDescription

▸ setLocalDescription(description, successCallback, failureCallback): Promise<void>

Deprecated

Parameters​

NameType
descriptionRTCLocalSessionDescriptionInit
successCallbackVoidFunction
failureCallbackRTCPeerConnectionErrorCallback

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.setLocalDescription

setRemoteDescription​

▸ setRemoteDescription(description): Promise<void>

Parameters​

NameType
descriptionRTCSessionDescriptionInit

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.setRemoteDescription

▸ setRemoteDescription(description, successCallback, failureCallback): Promise<void>

Deprecated

Parameters​

NameType
descriptionRTCSessionDescriptionInit
successCallbackVoidFunction
failureCallbackRTCPeerConnectionErrorCallback

Returns​

Promise<void>

Inherited from​

RTCPeerConnection.setRemoteDescription